home *** CD-ROM | disk | FTP | other *** search
/ HPAVC / HPAVC CD-ROM.iso / pc / FDSG227.ZIP / FDSTAT.TXT < prev    next >
Encoding:
Text File  |  1997-01-19  |  12.0 KB  |  276 lines
  1. FrontDoor Statistics Generator(tm)               (C)Copyright 1996 Scott Hall 
  2. -----------------------------------------------------------------------------
  3. -----------------------------------------------------------------------------
  4. 0. Index
  5. -----------------------------------------------------------------------------
  6.  
  7.  1. NetMailWare!?!?
  8.  2. AGREEMENT
  9.  3. Requirements
  10.  4. What the hell is FDStat?
  11.  5. What are all those numbers and stuff?
  12.  6. FDStat's FD Major Events Log
  13.  7. Switches
  14.  8. Future Enhancement
  15.  9. Thanks!!
  16. 10. COPYRIGHT
  17. 11. Version History with Fixes and changes documented.
  18. 12. Bug reports
  19.  
  20. -----------------------------------------------------------------------------
  21. 1. NetmailWare!?!?
  22. -----------------------------------------------------------------------------
  23.  
  24. This program is NetmailWare. Which means that you are free to use it as long
  25. as you wish for FREE! If you do plan on using this program all I would like
  26. is a Netmail message. I want to see how far this program gets and how popular
  27. it is/will be (if at all :) ). My address is Scott Hall at FidoNet 3:712/393
  28. or shall@idx.com.au for e-mail.
  29.  
  30. If you are impressed at getting this program for free then please consider
  31. a donation to a animal shelter or humanitarian organisation.
  32.  
  33. -----------------------------------------------------------------------------
  34. 2. AGREEMENT
  35. -----------------------------------------------------------------------------
  36.  
  37. FrontDoor Statistics Generator and FDSTAT is a Trade Mark owned by Scott Hall.
  38.  
  39. This program is (C)Copyright 1996 Scott Hall. I grant permission for any   
  40. person or company to use any of this program of portions thereof for any    
  41. purpose EXCEPT WHERE the subsequent product:                                
  42.                                                                             
  43.  a) is not available to the public free of charge.                          
  44.  b) is called "FrontDoor Statistics Generator" or "FDSTAT"                  
  45.                                                                             
  46. If you use this program, or portions thereof, you accept the above condions.
  47.  
  48. This program is running on my system and seems quite safe BUT this program
  49. may have bugs. This program only reads your FrontDoor log files and NEVER
  50. touches any other FrontDoor system files.
  51.  
  52. YOU USE THIS PROGRAM AT YOUR OWN RISK!!
  53.  
  54. I can not be held responsible for any loss, injury or death cause by using
  55. this program. You agree to pay all the costs of any damages and not hold me
  56. responsible for any loss, injury or death caused by this program.
  57.  
  58. You aggree to send me a netmail message.
  59.  
  60. Use of this program constitutes agreement to these conditions mentioned above.
  61.  
  62. -----------------------------------------------------------------------------
  63. 3. Requirements
  64. -----------------------------------------------------------------------------
  65.  
  66. * A FrontDoor log to read.
  67. * All options in FD menu Mailer>Log set to "Yes".
  68. * FD environment variable set to FrontDoor directory
  69.  
  70. -----------------------------------------------------------------------------
  71. 4. What the hell is FDStat?
  72. -----------------------------------------------------------------------------
  73.  
  74. Might it be easier to run the program to find out that?
  75. If so try the program first.... geeze!! :)
  76. A program should self be explainatory don't you think?
  77.  
  78. OK, so hopefully you have seen the nice and informative display. If not
  79. then (Oh No!) you have seen an error message. Follow the programs
  80. instructions or fix the error and try again. If this doesn't fix the
  81. problem send me a message (See bottom of this file).
  82.  
  83. -----------------------------------------------------------------------------
  84. 5. What are all those numbers and stuff?
  85. -----------------------------------------------------------------------------
  86.  
  87. The screen is divided into 6 windows and 3 information lines at the bottom
  88. of the screen.
  89.  
  90. PROCESSING WINDOW
  91.  
  92. Here you can watch (if you are quick!) what part of the FD (FrontDoor) Log
  93. is being processed at that moment.
  94.  
  95. INCOMING/OUTGOING POLLS
  96.  
  97. This display uses 2 windows. The columns of information/statistics of these
  98. 2 windows are:
  99.  
  100. <modem speed in KBPS>: <no. of pollings at this speed>/<no. of pollers at
  101. this speed> <volume received>/<volume sent> <send CPS rate>/<receive CPS rate>
  102.  
  103. NB: One of the "modem speeds" is SCR. If you use the scripting facility
  104.     within FrontDoor then modem CONNECT messages are not recorded in the
  105.     FD.LOG. Therefore no connect speed can be obtained by this program.
  106.     Therefore the statistic for scripted connections are shown under the SCR
  107.     value.
  108.  
  109.     Another "modem speed" is shown as "Tot" this is short for Total. This
  110.     row shows totals for all the other modem speeds except CPS rates. The
  111.     CPS rate in the Total row is an avarage.
  112.  
  113. CALLERS
  114.  
  115. Statistics on what Baud rates applied to human callers that FD passed onto
  116. your BBS.
  117.  
  118. Successful Connects = Successfully connected human callers
  119. Failed  = Calls that were not successful (assumed to be failed human callers)
  120. Rejects = Human callers rejected during NU (No Users) event.
  121.           ie. Event>Behaviour>"Allow User during Event" was set to 'No'
  122.  
  123. FILE TRANSFERS
  124.  
  125. Statistic on the type of files sent.
  126. TX      = Transmitted or sent files.
  127. RX      = Recieved files.
  128. DDn     = Count echomail bundles with the file extension in the format.
  129.           <Day><Day><number>. eg 1FC233D0.MO1 (in this MO = Monday)
  130. PKT     = Netmail Packets
  131. TIC     = Tick files
  132. Other   = any other type of file sent (perhaps File Attached Netmail).
  133. Pollers = Total time spent receiving and sending files when you were polled.
  134. Polling = Total time spent receiving and sending files when you were polling.
  135. $       = Phone costs as per FDNODE.CTL (which bears no resemblence to our
  136.           real phone bill costs here in Australia because we don't have
  137.           timed calls.. so Telstra tells us anyway!)
  138.  
  139. ERRORS
  140.  
  141. Pollers  = Errors encountered whilst another system was polling you.
  142. Polling  = Errors encountered whilst your system was was polling another.
  143. RX Files = Errors encountered whilst receiving a file from another system.
  144. TX Files = Errors encountered whilst sending a file to another system.
  145. Pwords   = Password session errors encountered.
  146. Others   = any other error not covered by the above.
  147.  
  148. INFORMATION LINES
  149.  
  150. The third last line shows the begin and end dates of the log being processed.
  151.  
  152. The second last line shows the last error message found and on the extreem
  153. right is where "Writing..." (ie BBS Screens or statistics to major events
  154. log), "Completed!" or "ABORTED!" (ie. Esc key was detected) is displayed.
  155.  
  156. Occasionally you may see a dark grey T or D, these indicate FDSTAT is time
  157. slicing so that other programs get a share of the CPU. T = General (ie OS/2,
  158. Windows, Windows95), D = DesqView 2.00 or greater.
  159.  
  160. The last line shows what log is being processed and where "major events" are
  161. being written to (See next section).
  162.  
  163. -----------------------------------------------------------------------------
  164. 6. FDStat's FD Major Event Log (MEL)
  165. -----------------------------------------------------------------------------
  166.  
  167. FDStat writes all major events found in FD Log to FDSTAT.LOG* In this file
  168. will be found errors, polling and poller events with simplified info. If
  169. you got FDStat to work before why not look in you FD Log directory and
  170. examine FDSTAT.LOG?
  171.  
  172. * This file name may be changed see "Switches" below.
  173.  
  174. -----------------------------------------------------------------------------
  175. 7. Switches
  176. -----------------------------------------------------------------------------
  177.  
  178. FDStat has 6 switches/parameters.
  179.  
  180.  FDStat [/LOG={ [Path] Log File}]  [/OUT={ [Path] Output File }]
  181.         [/BBS={BBS Screen Path}] [/NODE={Node}] [/NoPause] [/NoBeep]  
  182.  
  183.     /LOG=  is used to specify the path & file name of the FD log to be 
  184.            processed. If /LOG is not used it will default to FD.LOG in 
  185.            the FD directory. If only a file name is supplied it will 
  186.            look for it in the FD directory. If a full path and file name 
  187.            is supplied it will process that log file."
  188.  
  189.            *Note*: to use the current directory use /OUT=.\{filename}
  190.  
  191.     /OUT=  is used to direct the output to a path & filename. 
  192.            If /OUT is not used it will default to FDSTAT.LOG in the FD  
  193.            directory (See /NODE). If only a file name is supplied it will  
  194.            place it in the FD directory. If a full path and file name is   
  195.            supplied it will place the output there. 
  196.  
  197.            *Note*: to use the current directory use /OUT=.\{filename}
  198.  
  199.     /BBS=  Causes BBS style FDSTAT.ANS/ASC/ASL screens from statistics 
  200.            screen to be placed in the supplied directory. (See /NODE) 
  201.            ie. /BBS=C:\BBS\SCREENS\
  202.  
  203.     /NODE= is used to modify the the filenames FDSTAT.LOG and FDSTAT.ANS/ 
  204.            ASC/ASL (BBS Screens) to include a node number."
  205.            ie /NODE=1 will produce FDSTAT1.xxx  Other names not modified. 
  206.  
  207.            *Note*: Node number can only be 2 aphanumeric characters long.
  208.  
  209.            *Note*: /NODE could be used to keep multiple days worth of logs
  210.                    and BBS screens for a multinode BBS by using the /NODE=dn
  211.                    where d = day number and n = node number. Thereby
  212.                    FDSTATdn.LOG and FDSTATdn.ASC/ANS/ASL are produced.
  213.  
  214.     /NoPause   means that the program will not pause and wait for you  
  215.     /NP        to acknowledge the error message found in the FD log  
  216.                being processed. 
  217.  
  218.     /NoBeep    is used to stop the program from beeping when an an error  
  219.     /NB        message was found in the FD log being processed. 
  220.  
  221.     /TS=       is used to modify how often time slices are given back to
  222.                your multitasker. Lower number = more often, default is 9.
  223.                0 = no time slicing, force generic time slicing for DOS
  224.                networking TSRs by giving a non-zero value.
  225.                This program auto-detects Windows, Windows95, OS/2 and
  226.                DESQview.
  227.  
  228. ---------------------------------------------------------------------------
  229. 8. Future Enhancements
  230. ---------------------------------------------------------------------------
  231.  
  232. Depends on feedback.
  233.  
  234. ---------------------------------------------------------------------------
  235. 9. Thanks!!!
  236. ---------------------------------------------------------------------------
  237.  
  238. Thanks to:
  239. * David "If you can't make it work atleast make it look good!" Greene
  240.   for his help with this program.
  241. * The ßETA Team: Charlie Smith, Mark Ellis, Jeff Schrunk, Tom Van Overbeke,
  242.   Mark "Crazy Horse", Alex Zamorano, Ryan Frank, Kees Wiegel, James Ducan, 
  243.   Andrew Blume, Mike Jabour, John Bodoni, Danny Walters, Jeremy Idol, 
  244.   Sander Braaksma. Thanks a lot!
  245. * All others who have sent mail.
  246.  
  247. ---------------------------------------------------------------------------
  248. 10. COPYRIGHT
  249. ---------------------------------------------------------------------------
  250.  
  251. FDStat is Copyright 1995-1996 Scott Hall
  252. FrontDoor Statistics Generator is Copyright 1995-1996 Scott Hall
  253. FrontDoor is Copyright 1989-1994 Joaquim Homrighausen.
  254. TICK is Copyright 1988-1992 Barry Geller.
  255.  
  256. ...but only one is completely free! :)
  257. ---------------------------------------------------------------------------
  258. 11. Version History
  259. ---------------------------------------------------------------------------
  260.  
  261. See the file FDSTAT.HIS
  262.  
  263. ---------------------------------------------------------------------------
  264. 12. Bug Reports
  265. ---------------------------------------------------------------------------
  266.  
  267. Send bug reports, praise, hate mail, flames, bombs, flowers, money etc. to:
  268.  
  269.             Scott Hall
  270. FidoNet:    3:712/393
  271. E-mail:     shall@idx.com.au  (this one first)
  272. WWW:        http://www.idx.com.au/~shall
  273.  
  274. ---------------------------------------------------------------------------
  275. The End Finally... don't you just love writting doco? How was the spelling?
  276. ---------------------------------------------------------------------------